SJ 20523-1995 软件文档管理指南
ID: |
A3D18D72C97242808FFDFC962064498E |
文件大小(MB): |
1.84 |
页数: |
20 |
文件格式: |
|
日期: |
2024-7-27 |
购买: |
文本摘录(文本识别可能有误,但文件阅览显示及打印正常,pdf文件可进行文字搜索定位):
中华人民共和1 电子行业军用标准,FL 0137 SJ 20523-1995,软件文档管理指南,ヽ,Guideline for software documentation management,1995-05-25 发布1995-12-0I 实施,中华人民共和国电子工业部批准,次,范围. (1),1.1 主题内容……* (1),1.2适用范围,??。晻車(1) .,2 引用文件 (1),3定义. (1),4 一般要求. (1),5详细要求. (2),5.1 软件文档 (2),5.2 文档管理 . (7),5.3 所需资源(12),附录A文档政策检査表(参考件).. (13),附录B 文档计划检査表(参考件)…ハ.. (13),附录C文档管理规程检査表(参考件). (13),附录D 软件文档编制时间(参考件). (14),附录E 各评审点评审内容(参考件) (15),附录F软件文档签署者(参考件) (16),范,1.1,1.2,中华人民共和国电子行业军用标准,软件文档管理指南,Guideline for software documentation management,主题内容,SJ 20523 —1995,本指导性技术文件规定了软件文档种类、质量等级以及文档管理的详细要求,适用范围,本指导性技术文件适用于软件的开发、使用和维护,2引用文件,GB 8566— 计算机软件开发规范,GB 8567— 计算机软件产品开发文件编制指南,GB/T 11457—89,GJB 437一,GJB 438一,软件工程术语,军用软件开发规范,军用软件文档编制规范,3定义,除下列定义外,其它定义见GB/T 11457c,3.1 文档计划 documentation plan,ー个描述文档编制工作方法的管理用文档。该计划主要描述要编制佬类型的文档,这些,文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外,界因素,3.2 文档等级 level of documentation,对所需文档的ー个说明,它指岀文档的范围、内容、格式及质量。可以根据项目、费用、预,期用途、作用范围或其它因素选择文档等级,4 一般要求,软件文档是描述软件产品开发及开发结果、使产品能有效地使用或在合适的时候使产品,能转换或移植到其它环境的所有可复制又便于人们使用的资料,软件文档有六个重要功能:管理依据;任务之间联系的工具;质量保证;教育与参考;软件,维护支持;历史档案,软件文档分为开发文档和产品文档两类,中华人民共和国电子工业部!995-C5-25发布1995-12-01 实施,1,SJ 20523-1995,软件文档是计算机软件开发的ー个关键部分。如果文档有错,有遗漏,或未完成,则开发,工作必将受到损害,并且这类损害多半无法补救,好的文档依赖两个因素:较好的文档技术和管理工作。一旦管理人员清楚地理解软件文,档是什么,他们就能更好地计划,支持和监督文档工作,软件文档编制涉及整个软件开发生存周期,是面向用户的软件产品的一个必需的组成部,分。管理人员把文档工作提交给某个组织,并且按照他们制订的政策和过程对承担的义务提,供具体根据。管理人员帮助制订文档计划,确定需要哪些文档类型,提出文档内容的要点,确,定文档的质量要求,以及如何达到和保证质量要求。安排文档编制工作的优先次序,支撑文档,的制作、分发和更新,使文档要求和整个项目的要求相平衡,对有关软件开发的文档进行管理需要人员、设备和资金。管理人员负责分配资源,并在项,目开发的各个阶段维持这些资源,5详细要求,5.1 软件文档,5.1.I 文档用途,文档具有六个重要功能:,管理依据;,b.任务之间联系的工具;,c.质量保证;,d?教育与参考;,e. 软件维护支持;,f.历史档案,5.1.L!管 理依据,在系统开发过程中,管理部门必须了解开发进度,存在的问题和预期目标。根据进度表跟,踪进度,并根据下ー阶段计划安排的定期报吿提供了项目的可见性。定期报告还提醒各级管,理部门注意该部门对项目承担的责任以及它对该部门效率的重要性。开发文档规定若干个检,査点和进度表,使管理人员可以评定项目的进度。如果开发文档有遗漏,不完善,或内容陈旧,则管理人员将失去ー个跟踪和控制项目的重要エ,5.1.1.2 任务之间联系的工具,大多数软件开发项目通常被划分成若干个任务,并由不同的小组去完成。学科方面的专,家建立项目,分析员阐述系统需求,设计员为程序员制定总体设计,程序员提供详细的程序代,码,质量保证专家和审査员评价整个系统的完整性和性能,负责维护的程序员改进各种操作或,增强、扩充功能,这些人员需要以某种方式互相联系,从而提供了需要时可以复制、分发和引用的资料,因,而,任务之间的联系是文档的ー个重要功能。大多数系统开发方法为任务之间的联系规定了,ー些正式文档。分析员向设计员提供正式需求说明,设计员向程序员提供正式设计规格说明,等等,5.1.1.3 质量保证,那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试,该系统用的各种质量标准,以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰,2,SJ 20523-1995,说明。必须制订测试计划和测试规程,并报告测试结果。必须说明和评估安全控制、计算、检,验数(位)例行程序及其它控制技术。这些文档的提供可满足质量保证人员和审査人员的需,要,5.1.1.4教育与参考,软件文档的另ー个功能是使系统管理员、操作员、用户、管理人员和其它有关人员了解系,统如何工作,以及为了达到他们的各自的目的,如何使用系统,5……
……